Vcenter FoundationLoadBalancers NodeRuntimeInfo

The Vcenter FoundationLoadBalancers NodeRuntimeInfo schema defines load balancer node runtime information.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "vm": "string",
    "maintenance_mode": "string",
    "management_ip": "string",
    "deployment_status": "string",
    "deployment_notifications": [
        {
            "severity": "string",
            "title": "string",
            "message": "string",
            "time": "string"
        }
    ],
    "ha_status": "string",
    "health_status": "string",
    "health_notifications": [
        {
            "severity": "string",
            "title": "string",
            "message": "string",
            "time": "string"
        }
    ],
    "workload_alarms": [
        {
            "severity": "string",
            "title": "string",
            "message": "string",
            "time": "string"
        }
    ],
    "utilization": {
        "cpu": "string",
        "memory": "string"
    }
}

string

Optional

The identifier of virtual machine that runs the load balancer.

This property was added in vSphere API 9.0.0.0.

If missing or null, the virtual machine deployment is not complete.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: VirtualMachine. When operations return a value of this schema as a response, the property will be an identifier for the resource type: VirtualMachine.

string

maintenance_mode

Required

The load balancer node maintenance status, the value can be ENABLED, DISABLED or UNKNOWN, If ENABLED, the node does not process network traffic.

For more information see: Vcenter FoundationLoadBalancers MaintenanceMode.

This property was added in vSphere API 9.0.0.0.

string

management_ip

Optional

The management IP address of the load balancer node.

This property was added in vSphere API 9.0.0.0.

If missing or null means the management IP address is not configured or not ready.

string

deployment_status

Required

The deployment status of load balancer node.

For more information see: Vcenter FoundationLoadBalancers DeploymentStatus.

This property was added in vSphere API 9.0.0.0.

array of Vcenter FoundationLoadBalancers Notification

deployment_notifications

Optional

The notification messages used to describe the detailed process of deploying a load balancer node. The load balancer service will try to resolve possible deployment issues, for some resource issues the service can't deal with, it will notify the caller(s) to handle.

This property was added in vSphere API 9.0.0.0.

If missing or null means there is no deployment related messages need to notify to the caller(s).

string

ha_status

Required

The high availability status.

For more information see: Vcenter FoundationLoadBalancers HaStatus.

This property was added in vSphere API 9.0.0.0.

string

health_status

Required

The load balancer workload health status.

For more information see: Vcenter FoundationLoadBalancers HealthStatus.

This property was added in vSphere API 9.0.0.0.

array of Vcenter FoundationLoadBalancers Notification

health_notifications

Optional

Detailed notifications of health status.

This property was added in vSphere API 9.0.0.0.

If missing or null means there is no health related messages need to notify to the caller(s).

array of Vcenter FoundationLoadBalancers Notification

workload_alarms

Optional

The load balancer workload alarms.

This property was added in vSphere API 9.0.0.0.

If missing or null means no alarms were sent from workload.

utilization

Required

The combined status of load balancer node.

This property was added in vSphere API 9.0.0.0.